<div class="well well-small api-menu">
	<?php $this->widget('ApiMenuWidget'); ?>
</div>
<?php
$this->beginWidget('bootstrap.widgets.TbBox', array(
	'title' => false,
	'htmlOptions' => array('class' => 'api-doc'),
));
?>

<h2>删除数据</h2>
<p>根据主键删除索引数据</p>

<h4>URL</h4>
<p><code><?php echo $this->createApiUrl(); ?></code></p>

<h4>请求、响应方式</h4>
<p>POST 请求，JSON 响应。</p>

<h4>请求参数</h4>
<table class="table table-bordered">
	<tr><th>名称</th><th>必填</th><th>类型/范围</th><th>说明</th></tr>
	<tr>
		<td>access_token</td>
		<td>true</td>
		<td>string</td>
		<td>在登录授权后得到，参见<?php echo CHtml::link('如何登入', array('api/login')); ?>。</td>
	</tr>
	<tr>
		<td>project</td>
		<td>true</td>
		<td>string</td>
		<td>项目名称。</td>
	</tr>
	<tr>
		<td>id</td>
		<td>true</td>
		<td>string,array</td>
		<td>索引主键，参见注意事项。</td>
	</tr>
</table>

<h4>注意事项</h4>
<p>
	删除单条索引，只要以字符串形式传递主键值即可。如需要批量删除，则按以下形式传递数组值：
	<pre>id[]=1&id[]=2&id[]=3</pre>
</p>

<h4>成功返回</h4>
<p>
	<pre>{ "result":true, "count":1 }</pre>
</p>

<h4>结果说明</h4>
<table class="table table-bordered">
	<tr><th>名称</th><th>含义说明</th></tr>
	<tr>
		<td>result</td>
		<td>操作是否成功。</td>
	</tr>
	<tr>
		<td>count</td>
		<td>成功删除数据量。</td>
	</tr>
</table>

<h4>出错情况</h4>
<p>出错时 HTTP 的响应状态码为 200 以外的数值，含义如下：</p>
<table class="table table-bordered">
	<tr><th>HTTP 状态</th><th>出错说明</th></tr>
	<tr>
		<td>406</td>
		<td>缺少 ID 参数。</td>
	</tr>
	<tr>
		<td>500</td>
		<td>内部错误，通常是程序或数据库出错。</td>		
	</tr>
</table>

<?php $this->endWidget();?>
